Skip to content

add library pros and cons to README #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 26, 2023
Merged

Conversation

SethTisue
Copy link
Member

@SethTisue SethTisue commented Jan 26, 2023

Sometimes people stumble upon this library and figure that if it it's in the scala org it must be the bee's knees. I think we should foreground the reasons to choose it or not.

@SethTisue
Copy link
Member Author

@j-mie6 @johnynek LGTY? is anything major missing from the "weaknesses" section? accent on "major" — that section shouldn't be too long and needn't be comprehensive

@j-mie6
Copy link

j-mie6 commented Jan 26, 2023

I'd say that:

  • The API is a little disorganised and missing a few niceties that I'd expect from a modern PC library (like precedence combinators)
  • it doesn't seem to have any way of customising the error messages/formatting other than raw messages (including the output type being more structured than String)
  • it doesn't have any natural integration with something like cats? (perhaps that's too minor)

@SethTisue
Copy link
Member Author

Those are good observations, but maybe a bit too detailed. I added a bullet that says "Minimal feature set" in an attempt to cover it.

@j-mie6
Copy link

j-mie6 commented Jan 26, 2023

Perhaps "Rigid error messages" might be enough high-level for point 2?

@SethTisue
Copy link
Member Author

SethTisue commented Jan 26, 2023

Added: "Inflexible, unstructured error reporting"

(Incidentally, I wouldn't be opposed to linking to external resources with more detailed comparison info.)

@SethTisue
Copy link
Member Author

SethTisue commented Jan 26, 2023

merging... we can always change it further, whenever. thanks for the help

@SethTisue SethTisue merged commit decd4d7 into scala:main Jan 26, 2023
@SethTisue SethTisue deleted the honest-readme branch January 26, 2023 21:57
peteraldous pushed a commit to peteraldous/scala-parser-combinators that referenced this pull request Mar 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants